logger

object logger

Methods to log to the GitHub action log.

Coloring output is supported via ANSI escape codes. 3/4 bit, 8 bit and 24 bit colors are all supported.

See https://github.com/actions/toolkit/tree/main/packages/core#styling-output

Functions

debug

fun debug(message: String)

Log a debug message.

error

fun error(message: String)

Log an error message.

fun error(exception: Throwable)

Log exception as an error message.

fun error(message: String, annotationProperties: AnnotationProperties)

Log an error message.

fun error(exception: Throwable, annotationProperties: AnnotationProperties)

Log exception as an error message.

fatal

fun fatal(message: String)

Log a fatal message.

fun fatal(exception: Throwable)

Log exception as a fatal message.

info

fun info(message: String)

Log an info message.

notice

fun notice(message: String)

Log a notice message.

fun notice(exception: Throwable)

Log exception as a notice message.

fun notice(message: String, annotationProperties: AnnotationProperties)

Log a notice message.

fun notice(exception: Throwable, annotationProperties: AnnotationProperties)

Log exception as a notice message.

warning

fun warning(message: String)

Log a warning message.

fun warning(exception: Throwable)

Log exception as a warning message.

fun warning(message: String, annotationProperties: AnnotationProperties)

Log a warning message.

fun warning(exception: Throwable, annotationProperties: AnnotationProperties)

Log exception as a warning message.

withGroup

inline fun <R> withGroup(name: String, block: () -> R): R

Executes block within a fordable output group of name.

Properties

echoCommands

var echoCommands: Boolean?

Setter to set whether commands are echoed to the log.

isDebug

val isDebug: Boolean

Get whether the action is running in debug mode.

Sources

js source